Update evm_consumer functions implemented by XiangEnze · Pull Request #2 · Snapchain/finality-provider

XiangEnze · 2024-05-19T22:49:44Z

Summary

Updated EVMConfig for necessary addresses for evm_consumer, add some functions to avoid duplicates or large functions.

Import op-bindings:

go get "github.com/ethereum-optimism/optimism/op-bindings/bindings"

so we can interact with the L1 contract like the L2OutputOracle

Replaced evmclient with l1Client and l2Client, so we can reuse both to get information L1 and L2.
Using ethclient instead of rpc.client made functions much more lightweight.
Deleted useless functions.
Note that loading full blocks by BlockByNumber requires two requests, so use HeaderByNumber if we don't need all transactions or uncle headers.

Updated

QueryLatestFinalizedBlocks()
QueryBlocks()
QueryBlock()
QueryIsBlockFinalized()
queryLatestFinalizedNumber()

sdk "github.com/cosmos/cosmos-sdk/types" not used any more, already deleted
queryLatestBlocks() is not used any more, already deleted
implemented QueryLatestFinalizedBlocks()

Next Steps:

implement QueryActivatedHeight

Test Plan

make mock-gen
make test

bap2pecs

test plan is missing

examples:
https://github.com/babylonchain/finality-provider/pull/335
https://github.com/babylonchain/finality-provider/pull/336
https://github.com/babylonchain/finality-provider/pull/337

clientcontroller/evm_consumer.go

finality-provider/config/evm.go

…tedHeight

clientcontroller/evm_consumer.go

bap2pecs · 2024-05-20T20:31:34Z

clientcontroller/evm_consumer.go

+		Hash   string
+	}
+
+	var Batch []rpc.BatchElem


same here Batch should be batch

bap2pecs · 2024-05-20T20:32:40Z

clientcontroller/evm_consumer.go

+
+	var Batch []rpc.BatchElem
+
+	InitBatch(Batch, startnumber, count, "ascent")


InitBatch -> initBatch

if you check other function in the file, first-letter-capitalization is only for interface function.

bap2pecs · 2024-05-20T20:33:45Z

clientcontroller/evm_consumer.go

+			return nil, fmt.Errorf("error:%s", err)
+		}
+
+		ibatch := &types.BlockInfo{


what does ibatch mean? it's a block not a batch.

changed to block

bap2pecs · 2024-05-21T14:20:07Z

clientcontroller/evm_consumer.go

+
+	for _, batch := range batchArray {
+		nb := batch.Result.(*Block)
+		num, err := strconv.ParseUint(strings.TrimPrefix(nb.Number, "0x"), 16, 64)


this looks very wrong. query a block should be very simply and standard operation

the entire implementation of this function should be concise

bap2pecs · 2024-05-21T18:59:03Z

discussed w @XiangEnze and @lesterli offline. a few things:

rpc.Client is too low-level. we should use ethclient. no idea why we chose to use rpc.Client. it's not referenced anywhere in any docs
there is no good way to use ethclient to send batch rpc requests. but we can use standard HTTP library in golang to do it. similar to this. but this will increase the code complexity a lot. for now, we will just do a simple for-loop and worry about optimization later.
to get block: https://goethereumbook.org/block-query/
to query contract: https://goethereumbook.org/smart-contract-read/

references:

clientcontroller/evm_consumer.go

bap2pecs · 2024-05-23T03:40:18Z

clientcontroller/evm_consumer.go

+
+	var blocks []*types.BlockInfo
+
+	/*will be implemented in next PR, wait for "refactor: QueryLatestFinalizedBlocks(count uint64) -> QueryLatestFinalizedBlock() #347"


ok it's already merged now. see the msg in TG group and update accordingly

you also need to sync changes from upstream and change base branch

bap2pecs · 2024-05-23T03:41:45Z

clientcontroller/evm_consumer.go

 func (ec *EVMConsumerController) queryLatestBlocks(startKey []byte, count uint64, status finalitytypes.QueriedBlockStatus, reverse bool) ([]*types.BlockInfo, error) {
 	var blocks []*types.BlockInfo
-
+	// Can be deleted for never using


if it's easy to do, you can just remove it here

…ight

bap2pecs · 2024-05-24T15:01:15Z

Makefile


 .PHONY: test
 test:
+	make mock-gen


this should not exist

bap2pecs · 2024-05-24T15:02:17Z

finality-provider/config/evm.go

+	RPCL1Addr                      string `long:"rpc-address" description:"address of the L2 RPC server to connect to"`
+	RPCL2Addr                      string `long:"rpc-address" description:"address of the L1 RPC server to connect to"`


"RPCL1Addr - address of the L2 RPC"

bap2pecs · 2024-05-24T15:03:05Z

finality-provider/config/evm.go

-	RPCAddr string `long:"rpc-address" description:"address of the rpc server to connect to"`
+	RPCL1Addr                      string `long:"rpc-address" description:"address of the L2 RPC server to connect to"`
+	RPCL2Addr                      string `long:"rpc-address" description:"address of the L1 RPC server to connect to"`
+	L2OutputOracleContractAddress  string `long:"sol-address" description:"address of the L2output smart contract"`


L2output -> L2OutputOracle

bap2pecs · 2024-05-24T15:04:19Z

finality-provider/config/evm.go

+	RPCL1Addr                      string `long:"rpc-address" description:"address of the L2 RPC server to connect to"`
+	RPCL2Addr                      string `long:"rpc-address" description:"address of the L1 RPC server to connect to"`
+	L2OutputOracleContractAddress  string `long:"sol-address" description:"address of the L2output smart contract"`
+	BitcoinStackingContractAddress string `long:"sol-address" description:"address of the Bitcoinstaking smart contract"`


why this is also called long:"sol-address"? sounds wrong

what does "long" mean here?

lesterli and others added 17 commits May 11, 2024 21:46

feat: Split into ClientController and ConsumerController (#318)

289bbc4

feat: Add EVM config (#319)

d451545

fix tests & more split

9aa678e

QueryFinalityProviderVotingPower pseudo code

e54e921

add pseudo code for QueryActivatedHeight

41cd722

nit

caec997

enforce mock-gen before testing

c5c3c01

nit

22873ab

QueryBestBlock pseudo code

e8398f7

refactor

3fa7927

evm_consumer update

feecc8f

refactor

aa9041a

split ClientController and ConsumerController (Part 2) (#335)

252a328

Refactor QueryBestBlock() to only return the uint64 block height (#336)

5e6e9ad

Merge branch 'base/eth-support' into feat/SNA-427-QueryBlock-refactor

79ce5c6

nit

5119c64

for comments

79a0e20

bap2pecs requested changes May 20, 2024

View reviewed changes

Merge branch 'feat/SNA-427-QueryBlock-refactor' into feat/QueryActiva…

77421c3

…tedHeight

XiangEnze changed the base branch from feat/SNA-425-QueryBestBlock-refactor to feat/SNA-427-QueryBlock-refactor May 20, 2024 16:34

XiangEnze added 3 commits May 20, 2024 21:29

update after review

b992c72

rename var b

257a441

Printf err fix

4b3061e

bap2pecs requested changes May 20, 2024

View reviewed changes

rename respect of rules

d86f39c

bap2pecs reviewed May 21, 2024

View reviewed changes

XiangEnze added 2 commits May 22, 2024 21:56

feat : evm_consumer optimization

c12ab96

modify : rename queryLatestFinalizedNumber

43b1734

bap2pecs reviewed May 22, 2024

View reviewed changes

clientcontroller/evm_consumer.go Outdated Show resolved Hide resolved

modify : duplicate l2Client mistake

4329808

bap2pecs reviewed May 23, 2024

View reviewed changes

Merge branch 'base/consumer-chain-support' into feat/QueryActivatedHe…

a589bb3

…ight

XiangEnze changed the base branch from feat/SNA-427-QueryBlock-refactor to base/consumer-chain-support May 24, 2024 12:57

implement : QueryLatestFinalizedBlock()

a612773

bap2pecs requested changes May 24, 2024

View reviewed changes

XiangEnze added 2 commits May 24, 2024 19:51

correction : evm.cfg

bb0007e

correction : makefile merge problerm

f3cf85b


		var Batch []rpc.BatchElem

		InitBatch(Batch, startnumber, count, "ascent")


		var blocks []*types.BlockInfo

		/*will be implemented in next PR, wait for "refactor: QueryLatestFinalizedBlocks(count uint64) -> QueryLatestFinalizedBlock() #347"

		RPCL1Addr string `long:"rpc-address" description:"address of the L2 RPC server to connect to"`
		RPCL2Addr string `long:"rpc-address" description:"address of the L1 RPC server to connect to"`

Conversation

XiangEnze commented May 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Next Steps:

Test Plan

Uh oh!

bap2pecs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bap2pecs May 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bap2pecs commented May 21, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

XiangEnze commented May 19, 2024 •

edited

Loading

bap2pecs May 20, 2024 •

edited

Loading